/*
 * Copyright Java Operator SDK Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.javaoperatorsdk.operator.processing.event.rate;

import java.time.Duration;
import java.util.Optional;

import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter.RateLimitState;

public interface RateLimiter<S extends RateLimitState> {
  interface RateLimitState {}

  /**
   * @param rateLimitState state implementation
   * @return empty if permission acquired or minimal duration until a permission could be acquired
   *     again
   */
  Optional<Duration> isLimited(RateLimitState rateLimitState);

  S initState();
}
